feat: logs query endpoint #5202

waynexia · 2024-12-19T07:06:15Z

Signed-off-by: Ruihang Xia [email protected]I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

A basic implementation of v1/logs query interface. Example:

curl -X "POST" "http://localhost:4000/v1/logs" \                                                                                                                                                                            ─╯
    -H "Content-Type: application/json" \
    -d $'
    {
        "table": {
            "catalog_name": "greptime",
            "schema_name": "public",
            "table_name": "test_mem"
        },
        "time_filter": {
            "start": "2024-10-17"
        },
        "columns": [
            {
                "column_name": "message",
                "filters": [
                    {
                       "Contains": "production"
                    }
                ]
            },
            {
                "column_name": "ip",
                "filters": []
            },
            {
                "column_name": "timestamp",
                "filters": []
            }
        ],
        "context": "None"
    }
'

Checklist

I have written the necessary rustdoc comments.
I have added the necessary unit tests and integration tests.
This PR requires documentation updates.

Signed-off-by: Ruihang Xia <[email protected]>

coderabbitai · 2024-12-19T07:06:22Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

Signed-off-by: Ruihang Xia <[email protected]>

Copilot

Copilot reviewed 7 out of 22 changed files in this pull request and generated 1 comment.

Files not reviewed (15)

src/servers/src/http/logs.rs: Evaluated as low risk
src/auth/src/permission.rs: Evaluated as low risk
src/frontend/Cargo.toml: Evaluated as low risk
src/frontend/src/instance.rs: Evaluated as low risk
src/frontend/src/instance/logs.rs: Evaluated as low risk
src/frontend/src/server.rs: Evaluated as low risk
src/log-query/Cargo.toml: Evaluated as low risk
src/log-query/src/error.rs: Evaluated as low risk
src/log-query/src/log_query.rs: Evaluated as low risk
src/servers/src/metrics.rs: Evaluated as low risk
src/servers/src/interceptor.rs: Evaluated as low risk
src/servers/Cargo.toml: Evaluated as low risk
src/query/src/lib.rs: Evaluated as low risk
Cargo.toml: Evaluated as low risk
src/query/Cargo.toml: Evaluated as low risk

Comments suppressed due to low confidence (2)

src/query/src/log_query/planner.rs:112

Handle the case where time_filter.start might be None before using it in the filter expression.

lit(ScalarValue::Utf8(time_filter.start.clone()))

src/query/src/planner.rs:193

The plan_logs_query method should have unit tests to ensure the new functionality is covered.

async fn plan_logs_query(

src/query/src/log_query/planner.rs

Signed-off-by: Ruihang Xia <[email protected]>

Co-authored-by: Copilot <[email protected]>

Signed-off-by: Ruihang Xia <[email protected]>

codecov · 2024-12-19T08:38:55Z

Codecov Report

Attention: Patch coverage is 71.29187% with 120 lines in your changes missing coverage. Please review.

Project coverage is 83.82%. Comparing base (c9ad8c7) to head (0bb4d73).
Report is 16 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5202      +/-   ##
==========================================
- Coverage   84.11%   83.82%   -0.29%     
==========================================
  Files        1177     1188      +11     
  Lines      219078   220280    +1202     
==========================================
+ Hits       184276   184654     +378     
- Misses      34802    35626     +824

src/frontend/src/instance/logs.rs

src/log-query/src/log_query.rs

src/query/src/log_query/planner.rs

fengjiachun

Rest LGTM

src/log-query/src/log_query.rs

src/query/src/log_query/planner.rs

Signed-off-by: Ruihang Xia <[email protected]>

shuiyisong

🚀

* define endpoint Signed-off-by: Ruihang Xia <[email protected]> * planner Signed-off-by: Ruihang Xia <[email protected]> * update lock file Signed-off-by: Ruihang Xia <[email protected]> * add unit test Signed-off-by: Ruihang Xia <[email protected]> * fix toml format Signed-off-by: Ruihang Xia <[email protected]> * revert metric change Signed-off-by: Ruihang Xia <[email protected]> * Update src/query/src/log_query/planner.rs Co-authored-by: Copilot <[email protected]> * fix compile Signed-off-by: Ruihang Xia <[email protected]> * refactor and tests Signed-off-by: Ruihang Xia <[email protected]> --------- Signed-off-by: Ruihang Xia <[email protected]> Co-authored-by: Copilot <[email protected]>

waynexia added 5 commits December 6, 2024 14:31

define endpoint

0206414

Signed-off-by: Ruihang Xia <[email protected]>

planner

eca0182

Signed-off-by: Ruihang Xia <[email protected]>

Merge branch 'main' into log-query

c5dd6e8

update lock file

4810fa1

Signed-off-by: Ruihang Xia <[email protected]>

add unit test

da65626

Signed-off-by: Ruihang Xia <[email protected]>

waynexia requested review from evenyag and a team as code owners December 19, 2024 07:06

github-actions bot added the docs-required This change requires docs update. label Dec 19, 2024

sunng87 mentioned this pull request Dec 19, 2024

Update docs for feat: logs query endpoint GreptimeTeam/docs#1390

Open

waynexia added 2 commits December 19, 2024 15:20

fix toml format

5951792

Signed-off-by: Ruihang Xia <[email protected]>

Merge branch 'main' into log-query

2020f6e

waynexia requested a review from Copilot December 19, 2024 08:03

Copilot AI reviewed Dec 19, 2024

View reviewed changes

src/query/src/log_query/planner.rs Outdated Show resolved Hide resolved

waynexia and others added 2 commits December 19, 2024 16:07

revert metric change

993e5f7

Signed-off-by: Ruihang Xia <[email protected]>

Update src/query/src/log_query/planner.rs

4250c5f

Co-authored-by: Copilot <[email protected]>

waynexia requested review from killme2008, fengjiachun and shuiyisong December 19, 2024 08:15

fix compile

ce74bb7

Signed-off-by: Ruihang Xia <[email protected]>

shuiyisong reviewed Dec 20, 2024

View reviewed changes

src/frontend/src/instance/logs.rs Outdated Show resolved Hide resolved

src/frontend/src/instance/logs.rs Outdated Show resolved Hide resolved

src/log-query/src/log_query.rs Show resolved Hide resolved

src/query/src/log_query/planner.rs Outdated Show resolved Hide resolved

fengjiachun approved these changes Dec 23, 2024

View reviewed changes

src/log-query/src/log_query.rs Show resolved Hide resolved

src/query/src/log_query/planner.rs Show resolved Hide resolved

src/query/src/log_query/planner.rs Show resolved Hide resolved

refactor and tests

0bb4d73

Signed-off-by: Ruihang Xia <[email protected]>

waynexia requested a review from shuiyisong December 24, 2024 04:16

shuiyisong approved these changes Dec 24, 2024

View reviewed changes

waynexia added this pull request to the merge queue Dec 24, 2024

Merged via the queue into GreptimeTeam:main with commit 68dd291 Dec 24, 2024
31 of 36 checks passed

waynexia deleted the log-query branch December 24, 2024 06:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: logs query endpoint #5202

feat: logs query endpoint #5202

waynexia commented Dec 19, 2024

coderabbitai bot commented Dec 19, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Copilot AI left a comment

codecov bot commented Dec 19, 2024 •

edited

Loading

fengjiachun left a comment

shuiyisong left a comment

feat: logs query endpoint #5202

feat: logs query endpoint #5202

Conversation

waynexia commented Dec 19, 2024

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

Checklist

coderabbitai bot commented Dec 19, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Copilot AI left a comment

Choose a reason for hiding this comment

codecov bot commented Dec 19, 2024 • edited Loading

Codecov Report

fengjiachun left a comment

Choose a reason for hiding this comment

shuiyisong left a comment

Choose a reason for hiding this comment

coderabbitai bot commented Dec 19, 2024 •

edited

Loading

codecov bot commented Dec 19, 2024 •

edited

Loading